IntelliJ Platform Gradle Plugin/org.jetbrains.intellij.platform.gradle.tasks.aware/RunnableIdeAware

RunnableIdeAware

interface RunnableIdeAware : AutoReloadAware, CoroutinesJavaAgentAware, PluginAware, RuntimeAware, SandboxAware, SplitModeAware, JavaForkOptions

The interface which uses a set of various interfaces required for running a guest IDE.

See also

JavaForkOptions

Inheritors

Properties

Link copied to clipboard
@get:Internal
abstract val autoReload: Property<Boolean>

Enables auto-reload of dynamic plugins. Dynamic plugin will be reloaded automatically when its content is modified. This allows a much faster development cycle by avoiding a full restart of the development instance after code changes.

Link copied to clipboard
@get:Internal
@get:Optional
abstract val coroutinesJavaAgentFile: RegularFileProperty

The path to the coroutines Java Agent file.

Link copied to clipboard
@get:InputFiles
@get:PathSensitive(value = PathSensitivity.RELATIVE)
abstract val intelliJPlatformConfiguration: ConfigurableFileCollection

Holds the Configurations.INTELLIJ_PLATFORM configuration with the IntelliJ Platform dependency added. It should not be directly accessed.

Link copied to clipboard
@get:Internal
open val platformPath: Path

Provides access to the IntelliJ Platform dependency artifact path.

Link copied to clipboard
@get:InputFile
@get:PathSensitive(value = PathSensitivity.RELATIVE)
@get:Optional
abstract val pluginXml: RegularFileProperty

Holds the path to the patched plugin.xml file.

Link copied to clipboard
@get:Internal
open val productInfo: ProductInfo

Provides information about the IntelliJ Platform product. The information is retrieved from the product-info.json file in the IntelliJ Platform directory.

Link copied to clipboard
@get:Internal
abstract val runtimeArchitecture: Property<String>

An architecture of the Java Runtime currently used for running Gradle.

Link copied to clipboard
@get:InputDirectory
@get:PathSensitive(value = PathSensitivity.RELATIVE)
abstract val runtimeDirectory: DirectoryProperty

Java Runtime parent directory.

Link copied to clipboard
@get:Internal
abstract val runtimeLauncher: Property<JavaLauncher>

A custom JavaLauncher instance configured with the resolved runtimeDirectory.

Link copied to clipboard
@get:Internal
abstract val runtimeMetadata: MapProperty<String, String>

Metadata object of the Java Runtime currently used for running Gradle.

Link copied to clipboard
@get:Internal
abstract val sandboxConfigDirectory: DirectoryProperty

A configuration directory located within the sandboxContainerDirectory.

Link copied to clipboard
@get:Internal
abstract val sandboxContainerDirectory: DirectoryProperty

The container for all sandbox-related directories. The directory name depends on the platform type and version currently used for running a task.

Link copied to clipboard
@get:Internal
abstract val sandboxLogDirectory: DirectoryProperty

A log directory located within the sandboxContainerDirectory.

Link copied to clipboard
@get:Internal
abstract val sandboxPluginsDirectory: DirectoryProperty

A plugins directory located within the sandboxContainerDirectory.

Link copied to clipboard
@get:Internal
abstract val sandboxSuffix: Property<String>

Represents the suffix used i.e., for test-related tasks.

Link copied to clipboard
@get:Internal
abstract val sandboxSystemDirectory: DirectoryProperty

A system directory located within the sandboxContainerDirectory.

Link copied to clipboard
@get:Internal
abstract val splitMode: Property<Boolean>

Enables Split Mode when running the IDE.

Functions

Link copied to clipboard
abstract fun bootstrapClasspath(vararg classpath: Any): JavaForkOptions
Link copied to clipboard
abstract fun copyTo(options: JavaForkOptions): JavaForkOptions
abstract fun copyTo(p0: ProcessForkOptions): ProcessForkOptions
Link copied to clipboard
abstract fun debugOptions(action: Action<JavaDebugOptions>)
Link copied to clipboard
abstract fun environment(p0: MutableMap<String, *>): ProcessForkOptions
abstract fun environment(p0: String, p1: Any): ProcessForkOptions
Link copied to clipboard
abstract fun executable(p0: Any): ProcessForkOptions
Link copied to clipboard
@Internal
abstract fun getAllJvmArgs(): MutableList<String>
Link copied to clipboard
@Classpath
abstract fun getBootstrapClasspath(): FileCollection
Link copied to clipboard
@Input
abstract fun getDebug(): Boolean
Link copied to clipboard
abstract fun getDebugOptions(): JavaDebugOptions
Link copied to clipboard
@Nullable
@Optional
@Input
abstract fun getDefaultCharacterEncoding(): String?
Link copied to clipboard
@Input
abstract fun getEnableAssertions(): Boolean
Link copied to clipboard
abstract fun getEnvironment(): MutableMap<String, Any>
Link copied to clipboard
abstract fun getExecutable(): String
Link copied to clipboard
@Nullable
@Optional
@Input
abstract fun getJvmArgs(): MutableList<String>?
Link copied to clipboard
abstract fun getJvmArgumentProviders(): MutableList<CommandLineArgumentProvider>
Link copied to clipboard
@Nullable
@Optional
@Input
abstract fun getMaxHeapSize(): String?
Link copied to clipboard
@Nullable
@Optional
@Input
abstract fun getMinHeapSize(): String?
Link copied to clipboard
@Input
abstract fun getSystemProperties(): MutableMap<String, Any>
Link copied to clipboard
abstract fun getWorkingDir(): File
Link copied to clipboard
abstract fun jvmArgs(vararg arguments: Any): JavaForkOptions
abstract fun jvmArgs(arguments: MutableIterable<*>): JavaForkOptions
Link copied to clipboard
abstract fun setAllJvmArgs(arguments: MutableIterable<*>)
abstract fun setAllJvmArgs(arguments: MutableList<String>)
Link copied to clipboard
abstract fun setBootstrapClasspath(classpath: FileCollection)
Link copied to clipboard
abstract fun setDebug(enabled: Boolean)
Link copied to clipboard
abstract fun setDefaultCharacterEncoding(@Nullable defaultCharacterEncoding: String?)
Link copied to clipboard
abstract fun setEnableAssertions(enabled: Boolean)
Link copied to clipboard
abstract fun setEnvironment(p0: MutableMap<String, *>)
Link copied to clipboard
abstract fun setExecutable(p0: Any)
abstract fun setExecutable(p0: String)
Link copied to clipboard
abstract fun setJvmArgs(@Nullable arguments: MutableIterable<*>?)
abstract fun setJvmArgs(@Nullable arguments: MutableList<String>?)
Link copied to clipboard
abstract fun setMaxHeapSize(@Nullable heapSize: String?)
Link copied to clipboard
abstract fun setMinHeapSize(@Nullable heapSize: String?)
Link copied to clipboard
abstract fun setSystemProperties(properties: MutableMap<String, *>)
Link copied to clipboard
abstract fun setWorkingDir(p0: File)
abstract fun setWorkingDir(p0: Any)
Link copied to clipboard
abstract fun systemProperties(properties: MutableMap<String, *>): JavaForkOptions
Link copied to clipboard
abstract fun systemProperty(name: String, value: Any): JavaForkOptions
Link copied to clipboard
open fun validateIntelliJPlatformVersion()

Validates that the resolved IntelliJ Platform is supported by checking against the minimal supported IntelliJ Platform version.

Link copied to clipboard
open fun validateSplitModeSupport()

Validates that the resolved IntelliJ Platform supports Split Mode.

Link copied to clipboard
abstract fun workingDir(p0: Any): ProcessForkOptions